/*
 * Niiuzu
 * Copyright (C) 2011  Thierry Nowak
 * 
 * This program is free software: you can redistribute it and/or modify it under
 * the terms of the GNU General Public License as published by the Free Software
 * Foundation, either version 3 of the License, or (at your option) any later
 * version.
 * 
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
 * details.
 * 
 * You should have received a copy of the GNU General Public License along with
 * this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package com.niiuzu.shared.rpc;

import com.google.gwt.user.client.rpc.RemoteService;
import com.google.gwt.user.client.rpc.RemoteServiceRelativePath;
import com.niiuzu.shared.exception.EmailAddressAlreadyExistsException;
import com.niiuzu.shared.exception.ServiceRpcException;
import com.niiuzu.shared.exception.UnknownEmailAddressException;
import com.niiuzu.shared.exception.WrongUserReferenceException;
import com.niiuzu.shared.model.ClientContext;
import com.niiuzu.shared.model.User;
import com.niiuzu.shared.model.UserLogInResult;
import com.niiuzu.shared.model.UserSettings;

/**
 * Service dédié à l'utilisateur qui se connecte à l'application.
 */
@RemoteServiceRelativePath("userService")
public interface UserService extends RemoteService {

	/**
	 * Récupère les informations d'un utilisateur à partir de ses identifiants
	 * de connexion.
	 * 
	 * @param mail
	 *            adresse mail de l'utilisateur.
	 * @param password
	 *            mot de passe de l'utilisateur.
	 * @param rememberUser
	 *            <tt>true</tt> si l'utilisateur souhaite être authentifié
	 *            automatiquement lors de son prochain passage.
	 * @param context
	 *            identifie le contexte de la partie cliente.
	 * 
	 * @return les informations de l'utilisateur authentifié ou <tt>null</tt> si
	 *         aucun utilisateur ne correspond aux identifiants envoyés.
	 * 
	 * @throws ServiceRpcException
	 *             erreur technique.
	 */
	UserLogInResult logUserInFromCredentials(String mail, String password,
			boolean rememberUser, ClientContext context)
			throws ServiceRpcException;

	/**
	 * Récupère les informations d'un utilisateur automatiquement à la
	 * connexion.
	 * 
	 * @param cryptedUserReference
	 *            valeur cryptée d'un référence d'utilisateur.
	 * @param context
	 *            identifie le contexte de la partie cliente.
	 * 
	 * @return les informations de l'utilisateur authentifié ou <tt>null</tt> si
	 *         aucun utilisateur ne correspond aux identifiants envoyés.
	 * 
	 * @throws WrongUserReferenceException
	 *             la référence de l'utilisateur est incorrecte.
	 * @throws ServiceRpcException
	 *             erreur technique.
	 */
	UserLogInResult logUserInAtStartUp(String cryptedUserReference,
			ClientContext context) throws ServiceRpcException,
			WrongUserReferenceException;

	/**
	 * Création d'un nouveau compte utilisateur. A l'issu de cette création,
	 * l'utilisateur est considéré comme étant authentifié et ses informations
	 * sont retournées.
	 * 
	 * @param mail
	 *            adresse mail de l'utilisateur.
	 * @param password
	 *            mot de passe de l'utilisateur.
	 * @param context
	 *            identifie le contexte de la partie cliente.
	 * 
	 * @return les informations du nouvel utilisateur considéré désormais comme
	 *         authentifié.
	 * 
	 * @throws ServiceRpcException
	 *             erreur technique.
	 */
	UserLogInResult createUserAccount(String mail, String password,
			ClientContext context) throws ServiceRpcException,
			EmailAddressAlreadyExistsException;

	/**
	 * Récupération des préférences de l'utilisateur connecté.
	 * 
	 * @param user
	 *            utilisateur connecté.
	 * @param context
	 *            identifie le contexte de la partie cliente.
	 * 
	 * @return préférences de l'utilisateur.
	 * 
	 * @throws ServiceRpcException
	 *             erreur technique.
	 */
	UserSettings retrieveUserSettings(User user, ClientContext context)
			throws ServiceRpcException;

	/**
	 * Lance une requête au serveur pour résoudre un problème de mot de passe
	 * perdu par un utilisateur.
	 * 
	 * @param email
	 *            adresse email de l'utilisateur ayant perdu son mot de passe.
	 * @param context
	 *            identifie le contexte de la partie cliente.
	 * 
	 * @throws UnknownEmailAddressException
	 *             l'adresse email ne correspond à aucun utilisateur.
	 * 
	 * @throws ServiceRpcException
	 *             erreur technique.
	 */
	void solveLostPasswordProblem(String email, ClientContext context)
			throws ServiceRpcException, UnknownEmailAddressException;

}
